/*
 * The MIT License (MIT)
 *
 * Copyright 2021 Kwai, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.kuaishou.akdanmaku.ecs.component.action

import androidx.annotation.CallSuper
import com.badlogic.gdx.utils.Pool

/**
 * 一个被执行的对象行为
 *
 * @author Xana
 * @since 2021-07-14
 */
abstract class Action : Pool.Poolable {
  internal var pool: Pool<*>? = null

  internal open var target: ActionComponent? = null

  var duration: Long = 0L
  /**
   * do action
   * @return true if action is completed, otherwise false
   */
  abstract fun act(timeMills: Long): Boolean

  open fun restart() {}

  @CallSuper
  override fun reset() {
    pool = null
    target = null
  }

  /**
   * 一些操作过程中要避免执行途中被回收，将 pool 临时置空
   */
  protected fun holdPool(): Pool<*>? {
    val pool = this.pool
    this.pool = null
    return pool
  }
}
